formattedRect

Type

property

Summary

Reports the rectangle that surrounds all the objects in a card or group.

Syntax

get the formattedRect of {<card> | <group>}

get the formattedRect of <chunk> of <field>

Description

Use the formattedRect property to find the boundary of a group or chunk, or to determine the screen location of a chunk of text.

If you specify a card or group, the formattedRect reports the smallest rectangle that encloses all the object in that group or card. (Objects whose visible property is false are ignored.) The four items in the rectangle are:

1. horizontal distance from the left edge of the stack to the left edge of the rectangle
2. vertical distance from the top edge of the stack to the top edge of the rectangle
3. horizontal distance from the left edge of the stack to the right edge of the rectangle
4. vertical distance from the top edge of the stack to the bottom edge of the rectangle

The formattedRect of a chunk in a field is the smallest rectangle that encloses the entire chunk.

Examples

put the formattedRect of group "Nav Buttons" into rectToSelect

Related

keyword: card, items, field

property: visible, backSize, formattedLeft

command: group

glossary: object, property, chunk

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile